﻿// --------------------------------------------------------------------------------------------------------------------
// <copyright file="HeroldDataSet.cs" company="TomCorp">
//   Tom
// </copyright>
// <summary>
//   Defines the HeroldDataSet type.
// </summary>
// --------------------------------------------------------------------------------------------------------------------

namespace GeoCoder.Model {
    using System.Collections.Generic;
    using System.Diagnostics.CodeAnalysis;

    /// <summary>
    /// The search type.
    /// </summary>
    public enum SearchType {
        /// <summary>
        /// The yellow pages.
        /// </summary>
        YellowPages,

        /// <summary>
        /// The phone book.
        /// </summary>
        PhoneBook
    }

    /// <summary>
    /// The herold data set.
    /// </summary>
    [SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1650:ElementDocumentationMustBeSpelledCorrectly", Justification = "Reviewed. Suppression is OK here.")]
    public class HeroldDataSet {
        /// <summary>
        /// Gets or sets the type.
        /// </summary>
        public SearchType Type { get; set; }

        /// <summary>
        /// Gets or sets the total count.
        /// </summary>
        public int TotalCount { get; set; }

        /// <summary>
        /// Gets or sets the herold data.
        /// </summary>
        public List<HeroldData> HeroldData { get; set; }
    }
}
